/*
 * Copyright 2011 myTDev.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mytdev.util.properties.formatters.impl;

import com.mytdev.util.properties.formatters.AbstractFormatter;
import java.text.ParseException;
import java.util.regex.Pattern;

/**
 *
 * @author Yann D'Isanto
 */
public class BooleanFormatter extends AbstractFormatter<Boolean> {

    /**
     * The boolean valid string pattern.
     */
    private static final Pattern BOOLEAN_PATTERN = Pattern.compile("(?i)(true)|(false)");
    
    /**
     * Parses a Boolean from the specified string then returns it.
     *
     * @param string the string to parse.
     * @return the parsed Boolean.
     * @throws ParseException if the specified string is different from "true" 
     * or "false" ignoring case.
     */
    public Boolean parse(String string) throws ParseException {
        if(!BOOLEAN_PATTERN.matcher(string).matches()) {
            throw new ParseException("invalid boolean string", 0);
        }
        return Boolean.valueOf(string);
    }
}
